Query authorizations

Fetch specific authorization

Use this endpoint to fetch information about an Automatic Pix authorization

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:identifier'

Headers

Name	Description
x-delbank-api-key	Required. API key

Path Parameters:

Name	Type	Description
identifier	`string`	Required. Recurrence identifier

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
    "RecurrenceId": "RR999999182025050751897433907",
    "JdpiRequestId": "SC3822485720250507Q5fbI7GDMi9",
	"JdpiRequestAt": "2025-05-07T10:40:00.000Z",
	"SituationAt": "2025-05-07T10:40:00.000Z",
    "journey": 3,
    "FrequencyType": 1,
    "RecurrenceStartDate": "2025-06-01",
    "RecurrenceEndDate": "2025-12-30",
    "Amount": 100.50,
    "beneficiary": {
        "ispb": 21018182,
        "document": 76961727000105,
        "name": "Demo Pix Automatico"
    },
    "payer": {
        "type": "NATURAL",
        "document": "5876932582",
        "name": "Alisson Oliveira Neves ",
		"AccountNumber": "42790"
		"AgencyNumber": "1",
		"AccountType": "CURRENT",
        "MunicipalityIbgeCode": 2800308
    },
    "debtor": {
        "type": "NATURAL",
        "document": "5876932582",
        "name": "Renan Cesar Nunes ",
    },
	"ContractNumber": "1234556",
	"ContractDescription": "1234556",
    "RecurrenceCreatedAt": "2025-05-07T10:30:00.000Z",
    "RecurrenceUpdatedAt": "2025-05-07T13:24:28.848Z",
	"cancellations": []
}

Fetch all authorizations

This endpoint will fetch all the authorizations, be them sent or received

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations'

Headers

Name	Description
x-delbank-api-key	Required. API key

Path Parameters:

Name	Type	Description
flow	`enum`	Which journey to search for, values: `1`, `2`, `3`, `4`
startDate	`date`	The start date of the query
endDate	`date`	The end date of the query
page	`number`	The page number. Use this to paginate results depending on pageSize
pageSize	`number`	The amount of results returned per page
payerDocument	`string`	CPF or CNPJ
payerType	`enum`	`0` for CPF or `1` for CNPJ

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
    "jdpiAt": "2025-07-11T11:56:07.341Z",
    "authorizations": [
        {
            "recurrenceId": "RR3822895720250530oouu9uhf473",
            "jdpiRequestId": "01000000-6b39-f007-ae77-08ddbe34aa21",
            "jdpiRequestAt": "2025-07-08T15:32:35.838Z",
            "situationAt": "2025-07-11T11:56:07.339Z",
            "jdpiProcessingStatus": "CANCELLED",
            "jdpiStatus": "CANCELLED",
            "recurrenceRequestId": "SC3822485720250708zOvc11dAIpS",
            "authorizationResult": true,
            "journey": 2,
            "frequencyType": "ANNUAL",
            "recurrenceStartDate": "2025-07-02T00:00:00",
            "amount": 0,
            "floorMaxValue": 3,
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName"
            },
            "payer": {
                "ispb": "38224857",
                "type": "LEGAL",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "1",
                "accountNumber": "31275",
                "municipalityIbgeCode": 2800308
            },
            "debtor": {
                "type": "NATURAL",
                "document": "86829503086",
                "name": "Conta Teste 02"
            },
            "contractNumber": "1234567890ABC",
            "recurrenceCreatedAt": "2025-07-08T15:32:35.532Z",
            "recurrenceRequestCreatedAt": "0001-01-01T00:00:00",
            "recurrenceUpdatedAt": "2025-07-08T15:32:36.208Z",
            "recurrenceAuthorizationAt": "2025-07-08T15:32:35.532Z",
            "cancellations": [
                {
                    "cancellationId": "IC3822485720250708VKZEeiSo5lr",
                    "cancellationRequesterType": "LEGAL",
                    "cancellationRequesterDocument": "03284584000162",
                    "cancellationReason": "REQUESTED_BY_PAYER",
                    "cancellationAt": "2025-07-08T15:32:58.852",
                    "cancellationStatus": "ACCEPTED"
                }
            ]
        },
        {
            "recurrenceId": "RR3822895720250530oouu9uhf579",
            "jdpiRequestId": "01000000-6b39-f007-064d-08ddbaf6c2f7",
            "jdpiRequestAt": "2025-07-04T12:31:55.216Z",
            "situationAt": "2025-07-11T11:56:07.34Z",
            "jdpiProcessingStatus": "CANCELLED",
            "jdpiStatus": "CANCELLED",
            "recurrenceRequestId": "SC3822485720250704XW4Ezc6JCQT",
            "authorizationResult": true,
            "journey": 2,
            "frequencyType": "ANNUAL",
            "recurrenceStartDate": "2025-07-02T00:00:00",
            "amount": 0,
            "floorMaxValue": 1,
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName"
            },
            "payer": {
                "ispb": "38224857",
                "type": "LEGAL",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "1",
                "accountNumber": "31275",
                "municipalityIbgeCode": 2800308
            },
            "debtor": {
                "type": "NATURAL",
                "document": "86829503086",
                "name": "Conta Teste 02"
            },
            "contractNumber": "1234567890ABC",
            "recurrenceCreatedAt": "2025-07-04T12:31:54.899Z",
            "recurrenceRequestCreatedAt": "0001-01-01T00:00:00",
            "recurrenceUpdatedAt": "2025-07-04T12:31:55.563Z",
            "recurrenceAuthorizationAt": "2025-07-04T12:31:54.899Z",
            "cancellations": [
                {
                    "cancellationId": "IC3822485720250704LOsyy9u18lc",
                    "cancellationRequesterType": "LEGAL",
                    "cancellationRequesterDocument": "03284584000162",
                    "cancellationReason": "REQUESTED_BY_PAYER",
                    "cancellationAt": "2025-07-04T12:33:59.804",
                    "cancellationStatus": "ACCEPTED"
                }
            ]
        },
        {
            "recurrenceId": "RR3822895720250530oouu9uhf599",
            "jdpiRequestId": "01000000-6b39-f007-f071-08ddbaf624f6",
            "jdpiRequestAt": "2025-07-04T12:27:30.136Z",
            "situationAt": "2025-07-11T11:56:07.341Z",
            "jdpiProcessingStatus": "CANCELLED",
            "jdpiStatus": "CANCELLED",
            "recurrenceRequestId": "SC3822485720250704F5z7a3VcSBh",
            "authorizationResult": true,
            "journey": 2,
            "frequencyType": "ANNUAL",
            "recurrenceStartDate": "2025-07-02T00:00:00",
            "amount": 0,
            "floorMaxValue": 65,
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName"
            },
            "payer": {
                "ispb": "38224857",
                "type": "LEGAL",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "1",
                "accountNumber": "31275",
                "municipalityIbgeCode": 2800308
            },
            "debtor": {
                "type": "NATURAL",
                "document": "86829503086",
                "name": "Conta Teste 02"
            },
            "contractNumber": "1234567890ABC",
            "recurrenceCreatedAt": "2025-07-04T12:27:29.818Z",
            "recurrenceRequestCreatedAt": "0001-01-01T00:00:00",
            "recurrenceUpdatedAt": "2025-07-04T12:27:36.841Z",
            "recurrenceAuthorizationAt": "2025-07-04T12:27:29.818Z",
            "cancellations": [
                {
                    "cancellationId": "IC3822485720250709ho9zE0ltYCI",
                    "cancellationRequesterType": "LEGAL",
                    "cancellationRequesterDocument": "03284584000162",
                    "cancellationReason": "REQUESTED_BY_PAYER",
                    "cancellationAt": "2025-07-09T15:21:31.761",
                    "cancellationStatus": "ACCEPTED"
                }
            ]
        }
    ]
}

Fetch specific authorization​

Request​

Headers​

Path Parameters:​

Response​

Fetch all authorizations​

Request​

Headers​

Path Parameters:​

Response​

Fetch specific authorization

Request

Headers

Path Parameters:

Response

Fetch all authorizations

Request

Headers

Path Parameters:

Response